Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

JOSS paper on v3 #1461

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open

JOSS paper on v3 #1461

wants to merge 10 commits into from

Conversation

kartographer
Copy link
Contributor

Description

As mentioned on a few telecons, now that we finally got v3 out the door, I'd like to get a brief updated JOSS paper out about the new version.

I pulled the author list from the updated maintainers an authors list, putting maintainers + authors first and then authors only second. Obviously this is a first pass (and as such, institutions, names, OCRID IDs will need to get confirmed).

Comments welcome! I kept the update relatively short -- I thought about adding a section on major changes since v2, but decided against it for the moment (though I'd happy to discuss that or any other additions).

Motivation and Context

Types of changes

  • Documentation change (documentation changes only)

Checklist:

Documentation change checklist:

  • Any updated docstrings use the numpy docstring format.
  • If this is a significant change to the readme or other docs, I have checked that they are rendered properly on ReadTheDocs. (you may need help to get this branch to build on RTD, just ask!)

Copy link

codecov bot commented Jul 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.92%. Comparing base (283dda3) to head (b6b2f3b).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1461   +/-   ##
=======================================
  Coverage   99.92%   99.92%           
=======================================
  Files          61       61           
  Lines       21337    21337           
=======================================
  Hits        21322    21322           
  Misses         15       15           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@bhazelton bhazelton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking very good, just a few comments

paper.bib Outdated Show resolved Hide resolved
paper.md Outdated Show resolved Hide resolved
paper.md Outdated Show resolved Hide resolved
paper.md Outdated Show resolved Hide resolved
paper.md Outdated Show resolved Hide resolved
paper.md Outdated Show resolved Hide resolved
@kartographer kartographer marked this pull request as ready for review July 23, 2024 11:51
@kartographer
Copy link
Contributor Author

Alright, moving this out of draft status and into "ready" status, just to mark my intention to start wrapping this up.

@bhazelton @mkolopanis @steven-murray @adampbeardsley @dannyjacobs @nkern @aelanman @plaplant @jpober @PyxieLouStar -- can you check your author information (name, affiliation, and ORCID ID) and confirm that you are interested in being listed as a co-author? (I'm assuming as much for the current regulars on the weekly call, but want to try to touch base w/ everyone before submission). I'm hoping to get this out the door by Aug 20, so a response sooner rather than later would be appreciated!

@aelanman
Copy link
Contributor

Looks good to me!

Copy link
Contributor

@steven-murray steven-murray left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One comment on my affiliation, otherwise all good. Thanks @kartographer!

@kartographer
Copy link
Contributor Author

Noting that on the telecon we discussed adding a "what's new" section to the paper, so I'm going to work on adding that...

@dannyjacobs
Copy link
Contributor

Looks good to me too. Thanks for pushing this through Karto.

@plaplant
Copy link
Member

Looks good to me, thanks @kartographer!

@adampbeardsley
Copy link
Member

Looks good to me!

paper.bib Outdated Show resolved Hide resolved
@bhazelton bhazelton added docs documentation packaging labels Jul 24, 2024
paper.md Outdated Show resolved Hide resolved
paper.md Outdated Show resolved Hide resolved
paper.md Outdated Show resolved Hide resolved
paper.md Show resolved Hide resolved
@kartographer
Copy link
Contributor Author

@nkern @PyxieLouStar: I'm going to try and get this sent out, so I wanted to send one more ping -- can you confirm if you'd like to be on the paper (otherwise I'll assuming I should take you off). Thanks!

@nkern
Copy link
Contributor

nkern commented Aug 20, 2024

Hi @kartographer--sorry for the late response, i don't have github notifications on.. anyways, yes I'd be happy to be on the author list. Both my orcid and my affil are correct! lmk if anything else comes up. :)
thanks!

@PyxieLouStar
Copy link
Contributor

@kartographer my affiliation should be 3 rather than 2. Thank you!

@kartographer kartographer force-pushed the joss_update branch 2 times, most recently from beb62a1 to 1985db4 Compare August 27, 2024 15:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs documentation packaging
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants